home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 2 / Gold Medal Software Volume 2 (Gold Medal) (1994).iso / prog / hdk100b.arj / HLPDK.HDT < prev    next >
Text File  |  1993-11-03  |  66KB  |  1,703 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. The Help Engine Development Kit is a system that allows you to create 
  12. hyper-text database help systems with topics and hot links, using a simple
  13. text editor and the help compiler. 
  14.  
  15. The help databases can be distributed (free of charge) with the HELPENG or
  16. HE help engine display programs. 
  17.  
  18. The help database format is release to the public domain, if you own the 
  19. Paradox Engine you can use the help databases with your own programs. 
  20.  
  21. Borland Pascal Users can purchase the Help Engine Source Code even
  22. for Applications that do not use the paradox engine, using the Native Mem
  23. format.
  24.  
  25. The helpC compiler that is part of this development kit includes the
  26. ability to create Windows Help source files from the same source the 
  27. dos help sources are created!. Write your help once, and create help
  28. databases for Dos, Windows, OS/2 and DESQview/X !
  29.  
  30. Supported Formats :
  31. Native(PX), Native (Mem), Win30, Win31, QuickHelp, Microsoft Multimedia Viewer,
  32. THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, Word Processors (RTF)
  33.  
  34. From the same source you created your hypertext database, you can create
  35. a text document with automatic table of contents and index sections!
  36.  
  37. Using the RTF target you can prepare your professional documentation
  38. by generating word processors documents, all from the same source!
  39.  
  40. Features :
  41.  
  42. Topics, Popups, Links, Keywords, Text Formats, Navigational and
  43. Structural facilities, Target Code insertion, Multiple module files,
  44. Automatic Pascal/C/C++ reference generation, Exception handling,
  45. Multiple file target databases, Graphics, Sound, Groups, Application
  46. Launch, Automatic exports creation, User defined link templates and more.
  47.  
  48.  
  49. Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  50. Turbo Pascal programs, and use the help engine window in your pascal
  51. programs.
  52.  
  53. Related Topics :
  54. Registration
  55. Contact
  56. File List
  57. Credits
  58. Help Engine
  59. Help Compiler
  60. Quick Start
  61. Related Products
  62.  
  63.  
  64. *******************************************************************************
  65. *                 Why Register and registration instructions                  *
  66. *******************************************************************************
  67.  
  68. The Help Engine Development Kit (HLPDK) is a shareware product, if you 
  69. find this product valuable, please register it. 
  70. This section describes the reasons you should register.
  71.  
  72. By registering you will receive a complete discussion of the help engine 
  73. features, and many examples of usage. You will receive a diskette with the
  74. latest HLPDK version, and DPMI (DOS protected mode) versions of the help 
  75. compiler and engines!. (The memory version of the help engine can display 
  76. huge databases only in the protected mode version).
  77.  
  78. Your registration will help us to create the next versions of HLPDK, that
  79. will include more options, and features, some of them might even be your
  80. enhancement requests!.
  81.   
  82. A point to consider - If you want to create Windows Help source files,
  83. you will have to purchase a word processor that can output RTF files,
  84. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  85.  
  86. To order your registered copy of HLPDK please do one of the following:
  87.  
  88.  1.     Order from ISoft D&M:     
  89.  You can order directly from ISoft D&M. Please refer to the supplied 
  90.  HLPDK.REG file. Edit it, print it and mail it (with a check) to: 
  91.         ISoft D&M,  
  92.         POBox 5517
  93.         Coralville Iowa 52241, U.S.A
  94.  
  95.  2.     Order from PsL:
  96.  You can order from Public (software) Library with your MC, Visa, AmEx 
  97.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  98.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  99.  These numbers are for ordering only. ISoft D&M can NOT be reached at those 
  100.  numbers. Please contact ISoft D&M directly for any other type of problem 
  101.  (technical or other), information or request.
  102.                                               
  103. Related Topics :
  104. Contact
  105. Overview
  106.  
  107.   Please contact :
  108.  
  109.   ISoft D&M,  
  110.   P.O.B 5517
  111.   Coralville IA 52241,
  112.   U.S.A
  113.  
  114. ISoft D&M e-mail address : CompuServe - 76350,333
  115.  
  116.   To contact the author directly : 
  117.  
  118.   Contact :     Loewy Ron,
  119.                 9 Haneveem st.
  120.                 Herzeliya, 46465
  121.                 ISRAEL.
  122.  
  123. e-mail address : CompuServe - 100274,162
  124.  
  125. Related Topics :
  126. Regsiteration
  127. Overview
  128.  
  129.  This package contains the following files in the following archives :
  130.  
  131. Archive A :
  132. -----------
  133.  READMEA.HDK    - File List for Archive A.
  134.  HELPC.EXE      - Help Compiler.
  135.  HLPDK.DOC      - This file.
  136.  HELPC.DOC      - Help Compiler documentation
  137.  HLPDK.REG      - Registration file.
  138.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  139.  HLPDK.HLP      - WinHelp Version of the hlpdk hypertext source.
  140.  HLPDK.INF      - OS/2 IPF Version of the HLPDK hypertext source.
  141.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  142.  HELPDEMO.HDF   - Demo Help Project.
  143.  2NDDEMO.HDF    - Demo Help Project - file 2.
  144.  RONP.BMP       - Bitmap used in HLPDK.HDF
  145.  
  146. Archive B :
  147. -----------
  148.  READMEB.HDK    - File List for Archive B.
  149.  HELPENG.EXE    - Help Engine (Native Paradox).
  150.  HE.EXE         - Help Engine (Native Memory).
  151.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  152.  HLPDK.HDT      - Help Development Kit help database file. (Native Paradox)
  153.  HLPDK.SET      - Help Development Kit help database file.
  154.  HLPDKTOP.DB    - Help Development Kit help database file.
  155.  HLPDKTOP.PX    - Help Development Kit help database file.
  156.  HLPDKLNK.DB    - Help Development Kit help database file.
  157.  HLPDKLNK.PX    - Help Development Kit help database file.
  158.  HLPDKKEY.DB    - Help Development Kit help database file.
  159.  HLPDKKEY.PX    - Help Development Kit help database file.
  160.  MULTI1.HDF     - Multiple file target database demo - 1.
  161.  MULTI2.HDF     - Multiple file target database demo - 2.
  162.  MAKMULTI.BAT   - Demo multiple file target database batch file.
  163.  VWRLIB.HDF     - MMViewer Extention Library for 256 color bitmaps.
  164.  
  165. Related Topics :
  166. Overview
  167. Quick Start
  168.  
  169. HLPDK, HELPC, The Help Engines, NewsDB, IL2HDK, NG2HDK, RTF2HDK, RC2HDK and
  170. other products, were written by Ron Loewy. These products are distributed 
  171. worldwide by ISoft D&M.
  172.  
  173. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  174. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  175. (Trademarks of Borland International).
  176.  
  177. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  178. of Microsoft Corp.
  179.  
  180. The HELPENG program was written using the WINTEXT UI library, 
  181. (c) 1991,93 Loewy Ron.
  182.  
  183. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  184.  
  185. POPHELP is a copyright of TurboPower Software.
  186.  
  187. TVHC support, and other ideas were suggested by MunLeong Chan.
  188.  
  189. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  190. CASE code generators.
  191.  
  192. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  193. code generator.
  194.  
  195. Yaniv Golan helped me with beta-testing, debugging and suggestions.
  196. He is also the  author of the HPCHDK and POPHDK packages.
  197.  
  198. John Murphy notified me of the paragraph formatting difficulties that
  199. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  200.  
  201. DESQview/X is a trademark of Quarterdeck Office Systems.
  202.  
  203. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  204. excelent documentation of DESQview/X help format to generate code
  205. to this environment.
  206.  
  207. The HC31 problem with characters with ordinal values biggen than 127
  208. was solved thanks to Mr. Lars Fosdal of Norway.
  209.  
  210. OS/2 is a registered trademark of International Bussiness Machines.
  211.  
  212. The Text Cursor restore problem in the help engines was reported by Prof.
  213. Timo Salmi of the Univ. of VAASA, Finland.
  214.  
  215. D.J. Murdoch suggested the Cross Reference Report enhancements, and winhelp
  216. Go To Search list box title problem.
  217.  
  218. Word for Windows is a trademark of Microsoft corp.
  219.  
  220. WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
  221.  
  222. Lotus, AMI PRO are trademarks of Lotus corp.
  223.  
  224. Reuben Halevi from ISoft D&M did a lot to make this product real.
  225.  
  226. Slren Pingel Dalsgaard notified me of the small scroll box bug in helpeng, as
  227. well as some spelling mistakes in helpC.
  228.  
  229. Related Topics :
  230. Overview
  231.  
  232. From the command line enter HELPC HELPDEMO to compile the demo help database.
  233.  
  234. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  235. demo help database.
  236.  
  237. If you want to compile for windows :
  238.  
  239. from the command line enter HELPC HELPDEMO /W31
  240. and after that HC31 HELPDEMO
  241. (HC31 is the Microsoft Help Compiler)
  242. from windows, open the HELPDEMO.HLP file from the windows help engine.
  243. (Notice - if you do not have the HC help compiler from windows, we have
  244. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  245. able to feel the quality of the output that can be generated, and decide
  246. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  247. TPW, BP and probably some other packages), or download it from one of the
  248. sites Microsoft had uploaded it to).
  249.  
  250. If you use windows 3.0, or want your help file to be compatible with
  251. winHelp 3.0 use :
  252.         HELPC /W30 HELPDEMO
  253.         HC HELPDEMO
  254.  
  255. To compile for THELP use : 
  256.         HELPC /TH+ HELPDEMO
  257.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  258.  
  259. To compile for QuickHelp : 
  260.         HELPC /QH+ HELPDEMO
  261.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  262.  
  263. To compile for TVHC :
  264.         HELPC /TV+ HELPDEMO
  265.         TVHC HELPDEMO.TXT
  266.  
  267. To compile for POPHELP :
  268.         HELPC /PH+ HELPDEMO
  269.         MAKEHELP /Q HELPDEMO
  270.  
  271. To compile for DESQview/X :
  272.         HELPC /XD+ HELPDEMO
  273.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  274.         COPY HELPDEMO.HLP d:\DVX\HELP
  275.  
  276. To compile for Native Mem Format :
  277.        HELPC /MT+ HELPDEMO
  278. (Use HE HELPDEMO to view that database).
  279.  
  280. To compile for IPF (OS/2) format :
  281.        HELPC /OS2 HELPDEMO 
  282.        Switch to an OS/2 session.
  283.        IPFC /INF HELPDEMO
  284. (Use the VIEW Command to browse the database).
  285.  
  286. To compile for the Microsoft Multimedia Viewer 2.0 :
  287.        HELPC /MMV HELPDEMO
  288.        Open the MMViewer compiler (WMVC.EXE)
  289.        File|Open HELPDEMO.MVP
  290.        Compile (F5)
  291. (Use the VIEWER2.EXE program to browse the database).
  292.  
  293. To create a text document with table of contents, glossary and index :
  294.        HELPC /TXT HELPDEMO
  295.  
  296. To create a word processor document with table of contents, 
  297. glossary and index :
  298.        HELPC /RTF HELPDEMO
  299.        import helpdemo.rtf to your word-processor, and update fields.
  300.        (e.g. Microsoft WinWord : File|Open to open the document
  301.                                  Answer Yes to convert from Rich Text Format
  302.                                  Press F9 to update embedded format fields
  303.                                  somewhere in the first page (after the 
  304.                                  Table Of Contents title), and in the last 
  305.                                  page (after the index title).)
  306. Related Topics :
  307. Overview
  308. File List
  309.  
  310. To start the help engine program enter HELPENG on the command line, and 
  311. choose the help database you want to view from the list box. Use the Tab key
  312. to cycle between hot-link words, and press Enter to go to that link.
  313.  
  314. If you know the name of the SET file of the database you want to activate, you
  315. can enter it on the command line, and the help engine will display it.
  316.  
  317. If you have a mouse, you can use it to point at the hi-lighted links, and 
  318. activate them by pressing the left mouse button.
  319.  
  320. Press the ALT-T key combination to choose from a list of TOPICS in the 
  321. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  322. ALT-X to exit the help engine.
  323.  
  324. The exit command can be given by pressing the right mouse button.
  325.  
  326. Use F10 to open the menu bar, and use the arrow keys to navigate the 
  327. options. When you find the option you are interested in, Use the Enter
  328. key to execute it, or the Esc key to cancel. The menu bar can be navigated
  329. using the mouse as well.
  330.  
  331. To create a new help database please refer to the HELPC documentation
  332. file.
  333.  
  334. If you want to use the Native Mem Format Databases, Please use the supplied
  335. HE.EXE program. 
  336.  
  337. Related Topics :
  338. Trouble Shooting
  339. Overview
  340.  
  341. If you receive some kind of an error message while using the help development
  342. kit please refer to this section.
  343.  
  344. tableOps: xxxx error message :
  345. This message is generated by the Paradox Engine if an internal error occurs,
  346. if you receive a message that is not understood (e.g. Table is busy), 
  347. please try one of the following :
  348.  1. Try running the Help Compiler or the Help Engine with another input and 
  349.     notice if the problem exists, if it does, turn to the next entry,
  350.     otherwise try to see what the difference between the inputs is.
  351.  2. Check your free memory, try to move some TSR's from memory, or use the
  352.     protected mode compiler/engine available with the registered version.
  353.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  354.     with programs that use the Paradox Engine. If you receive a table busy
  355.     error, try to see if you have another program that uses the same table 
  356.     in another session (Windows/DESQview etc..).
  357.  4. PANIC - Please contact the distibuter/author for additional help.
  358.  
  359. Microsoft's HC31 help compiler will generate a error in RTF file error :
  360.  
  361.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  362.     still exists - please try steps 2 and 3, and notify the author. 
  363.  2. Use a binary disk editor to look at the character at the position x - 1
  364.     in the RTF file (where x is the error position reported by HC31).
  365.  3. Try to replace that charqacter from a special PC oem character to a 
  366.     "standard" ascii character (such as *). If the problem still occurs,
  367.     please contact ISoft D&M/The author, otherwise - you probably came 
  368.     accross a character that HC31 can not handle. In that case - try using
  369.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  370.     characters from your source HDF file.
  371.  
  372. Borland's HL help linker will generate a FE02: Out Of Memory error :
  373.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  374.     screen's definitions.
  375.  
  376. Borland's HL help linker will complain about undefined context numbers :
  377.  1. You probably have a contents.h file in the current directory, that hl
  378.     tries to use to bind the help topics to Borland's IDE on-line help,
  379.     try renaming this file, and re-compile with HL.
  380.  
  381. HelpC will not create the database when compiling to Native Mem (/MT+) :
  382.  1. Try compiling with report generation on (/R+) to Native Paradox
  383.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  384.     them, and re-try.
  385.  2. If the database is BIG, you might not have enough memory - Remember that
  386.     Native Mem tables are generated in memory. You will have to use the
  387.     HelpCX protected mode compiler (Available with the registered version).
  388.  
  389. HelpEng/HE will complain on an old-database when trying to open a help
  390. database with it :
  391.  1. Re-Compile the database using helpC.
  392.  
  393. HelpEng/HE will complain on un-supported database format, when trying to
  394. open a database :
  395.  1. HelpEng can not display Native Mem databases, and HE can not display
  396.     Native PX databases. Use the other help engine supplied.
  397.  
  398. HE will not be able to open a Native Mem database :
  399.  1. Use the protected mode HEX help engine. (Available for registered users).
  400.  
  401. Where is HL - Borland's Help Linker :
  402.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  403.     additional package called Borland Open Architecture (and Borlad OA for 
  404.     Pascal) that include among other things - the THELP help linker.
  405.  
  406. HelpEng/HE will complain on an old-database when tring to open a help
  407. database with it :
  408.  1. Re-Compile the database using helpC.
  409.  
  410. HelpEng/HE will complain on un-supported database format, when trying to
  411. open a database :
  412.  1. HelpEng can not display Native Mem databases, and HE can not display
  413.     Native PX databases. Use the other help engine supplied.
  414.  
  415. HE will not be able to open a Native Mem database :
  416.  1. Use the protected mode HEX help engine. (Available for registered users).
  417.  
  418. We have encountered some users that ran into problems, because they did 
  419. not use the dos SHARE program. We advise that you will always load the 
  420. SHARE program in your AUTOEXEC.BAT file.
  421.  
  422. Related Topics :
  423. Overview
  424. Help Engine
  425. Help Compiler
  426.  
  427. The HELPC help compiler is a dos command line program that receives a 
  428. help definition file (.HDF) and produce a help database. 
  429.  
  430.   The helpC command line is :
  431.  
  432.  HELPC source.fil [/NT:topic-table-name]
  433.                   [/NL:link-table-name] 
  434.                   [/ND:data-file-name] 
  435.                   [/NK:keywords-table-name] 
  436.                   [/D:conditional-define]
  437.                   [/ED=P|C|+]
  438.                   [/EL=x]
  439.                   [/FC+]
  440.                   [/EA+]
  441.                   [/R+]  [/ST-] [/CS+] [/EP+] [/WD-] [/RM-]
  442.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  443.                   [/PX+] [/MT+] [/OS2] [/TXT] [/RTF] [/PP+] [/MMV]
  444. When the target of the compiler is one of the native help engines
  445. the output of the compiler is a set data file called source.SET, that
  446. includes the names of the other help database components. 
  447.  
  448. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  449. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  450. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  451.  
  452. By default the help compiler does not produces a help cross reference 
  453. report on the topics/links used in the database, if the /R+ switch is set, 
  454. a cross-reference report will be generated, and database integrity indicators 
  455. will be given. Notice, however, that with the /R+ switch HELPC is much
  456. slower than with /R-.
  457.  
  458. IMPORTANT - Scan the output cross reference report for links defined, that
  459. are not defined as topics!
  460.  
  461. Notice - An additional switch is available that instructs the help compiler
  462. to indicate it's parse and code generation progress. Use the /EP+ switch to
  463. see that the helpC compiler is active. Please understand that the compile
  464. process can take a long time, on complex help databases. This switch does
  465. nothing more that ensure to you that the help compiler is alive. 
  466.  
  467. The /ST switch defines if the topic name defined in the .TOPIC command
  468. can include embeded spaces. By default this switch is set to /ST- (No
  469. embedded spaces).
  470.  
  471. The /CS switch turns Topics and Links case sensativity to ON. Use this
  472. switch with care - Only if you must have a lower/mixed case index in THELP
  473. or POPHELP use this switch. Notice that help databases that compile fine
  474. with case sensativity set to off, might fail to do so in case sensativity
  475. on. By deafult this switch is set to off (-).
  476.  
  477. The /XD switch generates code to the MDVXHELP help compiler, available
  478. free in the file DVXHLP10.ZIP on the Internet. When this switch is given,
  479. a set of cover and section files is generated, as well as a response
  480. file that should be used to compile the help database.
  481.  
  482. The /OS2 switch generates IPF source code. You must compile the generated code 
  483. with IPFC, from within an OS/2 session (window or full screen).
  484.  
  485. The /WD switch controls Warning Display. By default Warning Display is On, if
  486. you do not want to see the Warnings issued by the compiler when a topic name 
  487. or link are found to be incompatible with the target source, and helpC 
  488. translate them to be syntax compatible with the target.
  489.  
  490. Use the /RTF switch to create a word-processor ready RTF file, import this
  491. file (and update the fields e.g.- F9 in WinWord) to create a professional
  492. formatted documentation from the same source code!.
  493.  
  494. Use the /TXT switch to create a text file document from your .HDF source.
  495. With this feature you can create on-line help and printed documentation
  496. from the same source!.
  497.  
  498. The /RM- switch uses disk cross-reference report tables. Usage of this 
  499. option will allow the creation of cross-reference report for huge databases.
  500. This options will slow the creation of reports, use it only for databases
  501. so big that the report can not be generated using memory tables.
  502.  
  503. The /ED= switch creates the external references (if any are defined) in one
  504. of the following formats : /ED=P (Default) creates the external definitions
  505. in a pascal unit, /ED=C creates the external definitions in a C header 
  506. file, and /ED=+ creates a C++ header file.
  507.  
  508. The /EL= switch sets the Error Level used. This switch can be overriden
  509. by the .ERRORLEVEL statement. The acceptable error levels are :
  510.  
  511.       0    No Check  - (Default) - No action is taken.
  512.       1    Trap      - The link is replaced to a special topic named ERROR.
  513.       2    Strip     - The link is replaced by the Text part only.
  514.       3    Delete    - The text and link parts are deleted.
  515.       9    Abort     - helpC will abort with an error message, indicating the 
  516.                        line number.
  517. Please refer to the Exception Handling section below about helpC error
  518. processing.
  519.  
  520. The /FC+ switch forces topic collection, even if the error level is 0, that
  521. does not require collection.
  522.  
  523. Use the /PP+ switch to create an export file, to be used in multiple database
  524. target files projects.
  525.  
  526. The /EA+ switch is used to export all topics in a database, durin a 
  527. PreProcess target generation, compared to exporting only topics that
  528. have the .EXPORT attributes.
  529.  
  530. The /MMV switch is used to generate Microsoft Multimedia Viewer 2.0 code,
  531. You must use the WMVC.EXE program that came with your copy of the  Multimedia
  532. Publishing ToolKit (MM PTK) to compile this code.
  533.  
  534. Related Topics :
  535. Overview
  536. Command Line
  537. Help Engine
  538. Technical Documentation
  539.  
  540. The compiler switches are defined on the command line. These switches can
  541. be placed before and after the source file name. The compiler will look for
  542. a file named HELPC.CFG in the current directory, and process it before any
  543. command line switches are processed. 
  544.  
  545. Switches on the command line will over-ride switches set before them, on the
  546. command line or in one of the lines of the response options file(s).
  547.  
  548. Response option files can be specified by prefixing their name with a @ sign.
  549.  
  550.  
  551.  Examples :
  552.  
  553.  If our HELPC.CFG file, in the current directory is :
  554.  
  555. /W31
  556. /R-
  557.  
  558.  And we compile using HELPC HELPDEMO
  559.  
  560.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  561.  and no cross-reference report.
  562.  
  563.  Compile using HELPC HELPDEMO /r+
  564.  
  565.  Will create winhelp 3.1 sources, but a report will be generated.
  566.  
  567.  Compile using HELPC /w- HELPDEMO
  568.  
  569.  Will generate native format help database, no report is generated.
  570.  
  571.  If we have a file called MYSWITCH.CFG with the following lines :
  572.  
  573. /TH+
  574. /ST-
  575. /CS+
  576.  
  577.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  578.  
  579.  A THELP source, using Long Topic Names, with case sensitivity will be 
  580.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  581.  
  582. Related Topics :
  583. Overview
  584. Help Compiler
  585.  
  586.  
  587.  
  588. The Help Engine database is a combination of text that is read by the user,
  589. and a Topic and Links database that allows the user to view the topics
  590. he is interested in, using hyper-text methods.
  591.  
  592. This document describes the HLPDK language syntax, HELPC compiler operation
  593. and the native databases structure.
  594.  
  595. Related Topics :
  596. Help Compiler
  597. Help Engine
  598. Help Definition Format
  599. Native Format Structure
  600.  
  601.  
  602.   Each help database is built of 5 components : 
  603.  
  604.  1. Help Data File    - this file contains the raw text data.
  605.  2. Topic Index       - a database table that contains the topic names, and
  606.                         the references to the topics in the Data File.
  607.  3. Links Index       - a database table that contains the list of links 
  608.                         defined for each topic, and positional data.
  609.  4. Keywords Index    - a database table that contains the list of keywords,
  610.                         and the topics that have these keywords.
  611.  5. Set Data File     - a database configuration file that contains the
  612.                         names of the 3 components defined above, and some 
  613.                         additional information.
  614.  
  615. Version 1.x is the bare-bones version that includes only the basic
  616. operations needed from a hyper-text database, this version is implemented
  617. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  618.  
  619. Version 2.x has a new field in the topic table - the title field, help
  620. databases that were compiled with V1.x will not be executed by version
  621. 2.x, they will have to be re-compiled!.
  622.  
  623. Version 3.x fields have different length - the databases have to be 
  624. re-compiled.
  625.  
  626. Version 5.0+ has a new entry in the help set file, database have to be
  627. re-compiled, or the value 128 should be added in the last line of the help
  628. set file, and the version number should be changed to 5.0.
  629.  
  630. Version 6.0+ has added the keyword support - a new database table is added,
  631. and a new set format is defined. Help databases will have to be re-compiled
  632. for Natice targets.
  633.  
  634. In Version 7.0 the title field has been expanded once more - to 70 
  635. characters. Help databases will have to be re-compiled.
  636.  
  637. In Version 8.0 the tType field was added to the Topics database. Old databases
  638. will have to be re-compiled.
  639.  
  640. The format of the help database is released to the public domain, if
  641. you implement a database viewer on this database structure, I would be
  642. happy to receive a copy ..
  643.  
  644. Related Topics :
  645. Help Compiler
  646. Help Engine
  647. Help Definition Format
  648. Topic Index Format
  649. Links Index Format
  650. Keywords Index Format
  651. Set File Format
  652.  
  653.  
  654.   The help definition file format is as follows :
  655.  
  656. | remarks ...
  657. | remarks ...
  658. | 
  659. | .ENTRY topic-name
  660. | [.TITLE optional title for topic]
  661. | [.TITLEATTR paragraph attributes]
  662. | [.KEYWORDS optional keywords for topic]
  663. | [.GROUPS group1 [group2 ..]]
  664. | [.LIST optional browse list for topic]
  665. | [.EXPORT]
  666. | topic text and link reference .. 
  667. | topic text and link reference .. 
  668. | topic text and link reference .. 
  669. | topic text and link reference .. 
  670. | .END-ENTRY 
  671. | 
  672. | remarks ...
  673. | 
  674. | 
  675. | .ENTRY topic2-name
  676. | [.KEYWORDS keyword1 keyword2 ..]
  677. | [.GROUPS group3 [group2 ..]]
  678. | [.PARAGRAPH [paragraph attributes]]
  679. | topic 2 text and link reference .. 
  680. | topic 2 text and link reference .. 
  681. | topic 2 text and link reference .. 
  682. | [.END-PARAGRAPH]
  683. | additional topic2 text ...
  684. | .END-ENTRY 
  685. |
  686. | .POPUP popup-name
  687. | [.TITLE optional title for popup]
  688. |   definition for some reference
  689. |   ...
  690. | .END-POPUP
  691.  
  692.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  693.  the lines processed by the help compiler, to create the help database, 
  694.  every other line is considered a remark, and is not parsed or evaluated by
  695.  the help compiler.
  696.  
  697.   The topic text and link reference lines are simple text lines, with
  698.  special link marks.
  699.  
  700.   A sample will provide the details :
  701.  
  702. This is a text help line that includes one ~link~link-topic-name~ in it.
  703.  
  704.   This line will be displayed in the help engine program as :
  705.  
  706. This is a text help line that includes one link in it.
  707.  
  708.   The word "link" will be in a different color then the rest of the line, 
  709.  to indicate that this is a link. If the user hi-lights the link, and
  710.  presses Enter (or points the mouse cursor and clicks), the help engine will
  711.  look for a topic called "link-topic-name", and display it.
  712.  
  713.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  714.  
  715.  Notes :
  716.  
  717.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  718.   .  .END-ENTRY respectively.
  719.  
  720.     An equivalent pair of keywords are .TOP and .ENDTOP .
  721.  
  722.     You can use .EXT-TOPIC instead of .TOPIC/.ENTRY etc.. - topics created
  723.     with that statement are the same as regular topics, only - an external
  724.     reference is created for them to be linked to a pascal/C/C++ program.
  725.  
  726.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  727.  
  728.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  729.     is used as a title. The .TITLEATTR keyword is used to describe the
  730.     title text attributes. The syntax is the same as the .PARAGRAPH text
  731.     attributes. Please refer to the Text Attributes section below for further
  732.     discussion of the optional paragraph attributes.
  733.  
  734.  4. If you want the ~ sign to appear in your help database, use ~~ in your
  735.     help source file. (e.g. "This is a ~~" will be "This is a ~" in the final
  736.     help database.).
  737.  
  738.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  739.     specify the start and the end of a paragraph. This feature is currently 
  740.     supported only for MMViewer, winhelp, RTF and IPF sources. This feature is 
  741.     important if you want to create long paragraphs that will wrap correctly 
  742.     when a user resizes the help window. Please refer to the 
  743.     Text Attributes section below for further discussion of the optional 
  744.     paragraph attributes.
  745.  
  746.     The .PAR and .ENDPAR keywords can be used instead of the .PARAGRAPH 
  747.     and .END-PARAGRAPH keywords.
  748.  
  749.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  750.     end of the paragraph. These commands must appear as the first words in
  751.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  752.     of the help topic.
  753.  
  754.  
  755.  7. The optional .KEYWORDS command can appear after the .TITLE command
  756.     (If there is one), or the .TOPIC header (otherwise), Use this command
  757.     to help the user search for sets of topics that are connected to a 
  758.     specific keyword. The syntax of this command is :
  759.     .KEYWORDS keyword-1 keyword-2 ... 
  760.     Multiple .KEYWORDS lines are allowed, if there are a lot of KEYWORDS,
  761.     that will not fit on a single line, multiple .KEYWORDS lines can be
  762.     used. (NewsDB - The usenet hypertext generator uses that feature).
  763.  
  764.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define popup topics that 
  765.     are displayed on the same screen as the original topic that includes the
  766.     link to them. Popup entries allow the user to consult a glossary, and 
  767.     not lose the topic he was reading. Popups are supported in the winhelp,
  768.     OS/2 IPF, Native PX/Mem and MMViewer formats. In the other formats Popups are 
  769.     used as standard topics.
  770.  
  771.  9. In the Text/RTF targets .POPUP entries will be automatically included in a 
  772.     Glossary file that you can add as an appendix to your documentation.
  773.  
  774. 10. The .GROUPS statement associate a topic with several groups, you can 
  775.     create topics with menus to groups of other topics using the statement
  776.     ".INSERT GROUP group-name" in your topic text. Please refer to the 
  777.     Groups section of this document for additional discussion of this
  778.     function.
  779.     Multiple .GROUPS lines are allowed, if there are a lot of GROUPS,
  780.     that will not fit on a single line, multiple .GROUPS lines can be
  781.     used.
  782.  
  783. 11. The .LIST attribute associates a topic to a browse sequence, in this
  784.     name. The topic will be after the previous topic that belongs to this
  785.     list, and before the next topic that belongs to this list. The list
  786.     browse sequences are currently supported in the WINHELP and MMViewer
  787.     targets only.
  788.  
  789. 12. Graphic support is available by using a Graphic Link, a Graphic Link,
  790.     is a link that has the following format :
  791.     ~Text to display if not a graphic target~graphic-name~
  792.     Where graphic-name is the name of a graphic object defined with the
  793.     .GRAPHIC statement. Please refer to the Graphics Section below for more
  794.     information.
  795.  
  796. 13. If the .EXPORT attribute is specified, HELPC will automatically create
  797.     a reference to the topic in an export file. This function can be useful
  798.     when you create a multiple file target database. This command can be very
  799.     useful when you have to create a complex multi file database, and use a
  800.     'make' utility to maintain the project. For more information about this
  801.     attribute, please refer to the Complex Projects section below.
  802.  
  803. 14. Sound support is available by using a Sound link. This link will play a 
  804.     sound file, when the user clicks the link. The link has the following
  805.     format :  ~Text-That-Will-Appear~soundLinkName~
  806.     Where Text-That-Will-Appear will be displayed on the screen, and whem the
  807.     text will be clicked, the sound object defined as soundLinkName will be
  808.     played. Please refer to the Sound section below.
  809.  
  810. 15. Applications can be launced from the help database by clicking a link, that
  811.     was defined as an application. The syntax is : ~Text~application-link~
  812.     where Text is the text that will appear to the user, and application-link
  813.     is the identifier of the application that will be executed, as defined in
  814.     the .APPLICATION statement. Please refer to the Application Launch section
  815.     below for more information.
  816.  
  817. 16. User defined links can be created and used in the topic text, please refer
  818.     to the Links section below for discussion of this feature.
  819.  
  820. Additional commands include :
  821.  
  822. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  823. and high (selected) states in the native help formats.
  824.  
  825. The syntax of these commands is :
  826.  
  827. | .TEXTCOLOR w 
  828.  
  829. or
  830.  
  831. | .LINKCOLOR x
  832.  
  833. or
  834.  
  835. | .LINKHIGH y
  836.  
  837. Where w, x and y are the color of the text/link, which is a combination of the 
  838. color of the foreground with the color of the background multiplied by 16.
  839.  
  840. The colors that can be used for both fore and background are :
  841.  
  842.   Black     = 0
  843.   Blue      = 1
  844.   Green     = 2
  845.   Cyan      = 3
  846.   Red       = 4
  847.   Magenta   = 5
  848.   Brown     = 6
  849.   LightGray = 7
  850.  
  851. The colors that can be used only for the foreground are :
  852.  
  853.   DarkGray     = 8
  854.   LightBlue    = 9
  855.   LightGreen   = 10
  856.   LightCyan    = 11
  857.   LightRed     = 12
  858.   LightMagenta = 13
  859.   Yellow       = 14
  860.   White        = 15
  861.  
  862. For example : to set the normal color of a link to light green on blue, use
  863.  
  864. | .LINKCOLOR 26
  865.  
  866. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  867.  
  868. Creating Multiple Source Projects :
  869.  
  870. Use the .INCLUDE commands in the source of your .HDF file, to include an
  871. additional source file. .INCLUDE is not supported in the middle of a topic.
  872.  
  873. For Example :
  874.  
  875.  .. some stuff 
  876.  
  877. | .include 2ndfile.hdf
  878.  
  879.  .. additional stuff
  880.  
  881. will process 2NDFILE.HDF in the middle of our source file.
  882.  
  883. Please notice - .INCLUDE commands can be nested in your source file,
  884. it is however not recommended to nest them too deep, helpC does not
  885. close the input file when a .INCLUDEd file is processed, in order to
  886. minimize help generation time - there is however, a limit on the number
  887. of open files that can be used by a program - this is a limit set by dos.
  888.  
  889. Code Insertion :
  890.  
  891. Use the .INSERT CODE statement to insert target code that will not be 
  892. translated by helpC. helpC will send un-translated code to the output target
  893. until a .END-CODE statement is found.
  894.  
  895. For example - creating a small table in winhelp format :
  896. | .. normal code
  897. | .ifdef windows
  898. | .insert code
  899. | \pard{\tab column1\tab column2\tab column3}\par
  900. | \pard{\par col1data\tab col2data ..}\par
  901. | .end-code
  902. | .endif
  903.  
  904. GUI Font based targets :
  905.  
  906. The .FIXEDFONT command is used to define a non proportional font as the 
  907. default font of the help database. Currently the only targets affected
  908. by this command are MMViewer, winHelp, RTF. If you find that your help 
  909. databases are not aligned after they are converted to winHelp format, use 
  910. this command and re-compile. This command has no effect on targets that are 
  911. different from the targets mentioned above.
  912.  
  913. The .PCFONT command is used to define a font that has the standard pc 
  914. character set (Terminal - in windows). If you convert a text based 
  915. database that uses the PC's special characters, use this command to
  916. set the default font. This command has no effect on targets that are 
  917. different from the targets mentioned above.
  918.  
  919. Text targets :
  920.  
  921. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in
  922. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy .
  923.  
  924. Font Pallete :
  925.  
  926. Use the .SETFONT command to change or add fonts to the font palette, The 
  927. syntax is : .SETFONT font-number 'Font-Name-In-The-Target-Language'. If
  928. for example we would like to change font number 3 in the windows target
  929. to be a font X of family Y we would write : 
  930. | .SETFONT 3 'Y X'
  931.  
  932. Text Attributes :
  933.  
  934. Use the .TITLEDEFAULTS statement to set the default text attributes of the
  935. topics titles in the help database. These defaults can be over-ridden with
  936. the .TITLEATTR statement in the topic definition. Please refer to the Text
  937. Attributes section below for discussion of paragraph text attributes.
  938.  
  939. Use the .ATTRDEFAULTS statement to set the default text attributes of 
  940. paragraph text in the database. Please refer to the Text Attributes section 
  941. below.
  942.  
  943. Error Handling :
  944.  
  945. Use the .ERRORLEVEL command to set the error level. The syntax is .ERRORLEVEL x
  946. where x is one of the following :
  947.  
  948.       0    No Check  - (Default) - No action is taken.
  949.       1    Trap      - The link is replaced to a special topic named ERROR.
  950.       2    Strip     - The link is replaced by the Text part only.
  951.       3    Delete    - The text and link parts are deleted.
  952.       9    Abort     - helpC will abort with an error message, indicating the 
  953.                        line number.
  954. Please refer to the Exception Handling section below about helpC error
  955. processing.
  956.  
  957. Alias Topics :
  958.  
  959. Use the .ALIAS command to substitute a Popup/Topic name with another name. The
  960. syntax is .ALIAS newname origname. Whenever a newname link is found, the alias
  961. of origname is used. This can be very useful when you want to give multiple
  962. names to a topic, or when HLPDK source is the target of an incremental 
  963. compiler.
  964.  
  965. Graphic Support :
  966.  
  967. Use the .GRAPHIC statement to define a graphic object, that can be referenced
  968. elsewhere in your document. 
  969. The syntax is :
  970. | .GRAPHIC graphic-name path-to-graphic-file
  971. Please refer to the Graphics section below, for further information.
  972.  
  973. External Links :
  974.  
  975. Use the .EXTLINK command to define links in external database file. With this 
  976. command you can create multiple file target database projects. Please refer to
  977. the Links section below for more information about this feature.
  978.  
  979. Sound Support :
  980.  
  981. Use the .SOUND command statement to define a sound object, that can be used as
  982. a Sound link elsewhere in your document.
  983. The syntax is :
  984. | .SOUND sound-name sound-file-name
  985. Please refer to the Sound section below for more information about this feature.
  986.  
  987. Application Launch :
  988.  
  989. The .APPLICATION statement is used to define an application object that can be
  990. launced by an application-launch-link. The syntax is :
  991. | .APPLICATION application-identifer application-definition
  992. where application-identifer is the identifer that will be used in 
  993. application-launch-links, and application-definition is the path to the
  994. application. If the application needs to get parameters, the path and the
  995. parameters are specified in quotes. Please refer to the Application Launch
  996. section below for additional information.
  997.  
  998. External Routines Support :
  999.  
  1000. The .ROUTINE statement can be used to define external routines that can be 
  1001. called from the help database. The syntax is :
  1002. | .ROUTINE routine-name module-name parameter-definition
  1003. Where routine-name is the name of the procedure/function to be called, 
  1004. module-name is the name of the library/DLL that the routine resides in (No need
  1005. to add the .DLL extention), and parameter-definition is the definition of the
  1006. parameters that the routine receives.
  1007. The parameter definitions is a string with one character describing each
  1008. parameters type. The following definitions are used :
  1009.  
  1010. char    C definition               Pascal definition
  1011.  
  1012. u    unsigned short (WORD)      Word
  1013. U    unsigned long  (DWORD)     Longint
  1014. i    short int                  byte
  1015. I    int                        integer
  1016. s    near char * (PSTR)         PChar
  1017. S    far char * (LPSTR)         PChar
  1018. v    void 
  1019.  
  1020. Embedding Files :
  1021.  
  1022. Use the .EMBEDD statement to add files to your help database. The files defined
  1023. as embedded will appear in the [baggage] section of your winHelp/MMViewer 
  1024. project definition and will be stored with the rest of the database.
  1025.  
  1026. The syntax is :
  1027.  
  1028. | .EMBEDD file-id path-to-file
  1029.  
  1030. Where file-id is the name the file will be referenced by, and path-to-file is
  1031. the path to the file on the author's machine.
  1032.  
  1033. Related Topics :
  1034. Technical Documentation
  1035. Conditional Defines
  1036. Groups
  1037. Text Attributes
  1038. Graphics
  1039. Sound
  1040.  
  1041. Links are the special "commands" embedded in a topic text, that provide
  1042. special functionality in the target database.
  1043.  
  1044. All links are described in the topic text as a combination of text that will
  1045. appear, and a link identifier.
  1046.  
  1047. The syntax, in a topic text for a link is :
  1048.  
  1049.  .. Some Standard Text .. ~Link Text~Link Id~ .. some more text ..
  1050.  
  1051. Link Id is a unique identifier that describe this link.
  1052.  
  1053. The most common link, is a topic link, this link allows the user to click on
  1054. the Link Text, that is usually in a different color than the rest of the text,
  1055. and by clicking on this texst, the topic in the help engine window is replaced,
  1056. with the topic that has the same identifier as the Link Id specified in the
  1057. identifier.
  1058. (A Topic is defined by a .topic statement somewhere else in the source file).
  1059.  
  1060. Another type of link, is the Popup link. When the Link Id is the Id of a popup,
  1061. clicking on the link will display the popup text in a window, and retain the 
  1062. original topic in the help engine window. 
  1063. (A Popup is defined by a .popup statement somewhere else in the source file).
  1064.  
  1065. Links can be used, to embedd non-textual information in the topic text. A 
  1066. common non-textual is a graphic link, when the Link Id is the Id of a graphic
  1067. object (defined by a .graphic statement somewhere else in our source), the
  1068. place of the link will be replaced by a graphic picture, in targets that 
  1069. support graphics (such as WINHELP and OS/2 IPF), and remain the Link Text
  1070. in targets that do not supprot graphics.
  1071.  
  1072. Another non-textual link is a sound link. A sound link plays a sound file 
  1073. when a sound object (defined with the .SOUND statement) is clicked by the
  1074. user. 
  1075.  
  1076. Applications can be lauched from a link, when the link key is the identifer of
  1077. an application defined with the .APPLICATION statement.
  1078.  
  1079. Other links can be created using "User Defined Link Templates", with this 
  1080. feature a link template can be created to support additional code translations.
  1081. Please refer to the Extending HDF section below for additional information
  1082. on User defined links.
  1083.  
  1084. When HELPC recognizes a link, the following sequence of
  1085. link recognition occurs -
  1086. 1. Try to match link with a graphic object.
  1087. 2. If failed - try to match link with a sound object.
  1088. 3. If failed - try to match link with an application object.
  1089. 4. If failed - try to match link with a user defined link.
  1090. 5. If failed - try to match link with a popup.
  1091. 6. If failed - try to match link with a topic.
  1092. 7. If failed - try to match link with an external topic. (.EXTLINK)
  1093. 8. If failed - opearate according to the current error-level.
  1094.  
  1095. Related Topics :
  1096. Application Launch
  1097. Graphics
  1098. Sound
  1099. Exception Handling
  1100. Technical Documentation
  1101. .HDF Syntax
  1102. Help Compiler
  1103.  
  1104. The helpC compiler supports conditional define directives that allow you to
  1105. tailor your source according to define symbols that are known to the compiler.
  1106.  
  1107. You can use the .ifdef, .ifndef, .else and .endif directives to test the
  1108. target of your compile and do different things according to this target.
  1109.  
  1110. If for example you have a Windows bitmap you want to include in your generated
  1111. RTF file, when you compile to winhelp format, but, you would like to use a
  1112. statement in other targets that do not support graphics, you could do the 
  1113. following :
  1114.  
  1115. | .ifdef windows
  1116. |   some text {\bmc mybmp.bmp\} some more text
  1117. | .else 
  1118. |   some text AND STATEMENT HERE some more text
  1119. | .endif
  1120.  
  1121. When the compiler will generate the code, the RTF command \bmc will be 
  1122. inserted in the output of the compiler for windows targets (/W30, /W31), 
  1123. and a simple text statement will be inserted otherwise.
  1124.  
  1125. The conditional directives supported are :
  1126.  
  1127. | .ifdef  SYMBOL - Compile code only if SYMBOL is defined.
  1128. | .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined.
  1129. | .endif         - Any .ifdef/.ifndef should be terminated by a .endif .
  1130. | .else          - Reverse the previous .ifdef/.ifndef
  1131.  
  1132. The following SYMBOLS are automatically defined by the compiler :
  1133.  
  1134. Symbol          When Defined
  1135. ------          ------------
  1136. DEF             /PX+
  1137. W31             /W31
  1138. W30             /W30
  1139. THS             /TH+
  1140. QHS             /QH+
  1141. TVH             /TV+
  1142. PHS             /PH+
  1143. DVX             /XD+
  1144. MEM             /MT+
  1145. OS2             /OS2
  1146. TXT             /TXT
  1147. WINDOWS         /W30, /W31
  1148. THELP           /TH+
  1149. QUICKHELP       /QH+
  1150. TVHC            /TV+
  1151. NATIVEPARADOX   /PX+
  1152. POPHELP         /PH+
  1153. DESQVIEW/X      /XD+
  1154. NATIVEMEMORY    /MT+
  1155. VERx.y          When Compiling with helpC Vx.y 
  1156. NATIVE          /PX+, /MT+
  1157. DOCUMENT        /TXT, /RTF
  1158. RTFBASED        /W+, /RTF, /W30, /W31, /MMV
  1159. PRP             /PP+
  1160. PREPROCESS      /PP+
  1161. MMV             /MMV
  1162. MMVIEWER        /MMV
  1163. VIEWER          /MMV
  1164.  
  1165. You can define your own conditional defines on the command line using the /D:
  1166. switch of helpC.
  1167.  
  1168. e.g.
  1169.  
  1170. Source :
  1171.  
  1172. | ... some text ..
  1173. | .ifdef mydef
  1174. |   Special Text for mydef situation
  1175. | .endif
  1176. | ... more text
  1177.  
  1178. and you compile using HELPC /D:MYDEF the special text will be included.
  1179.  
  1180. Related Topics :
  1181. Technical Documentation
  1182. Help Definition
  1183.  
  1184.  
  1185. Topic's text can receive visual attributes such as a font, size, bold, 
  1186. italic etc.. by using the paragraph attributes on the .PARAGRAPH (.par)
  1187. line. Text attributes are currently supported in the MMViewer, winhelp and rtf 
  1188. targets.
  1189.  
  1190. The attributes that can be applied to text are :
  1191.  
  1192. Font            - The font the text will be displayed in.
  1193. Bold            - The text is displayed in bold characters.
  1194. Italic          - The text is displayed in italic characters.
  1195. Underline       - The text is displayed in underline characters.
  1196. Size            - The size of the font.
  1197. Box             - The paragraph can be contained in a box.
  1198. Align           - The paragraph can be alligned.
  1199. Color           - The text foreground color.
  1200.  
  1201. The syntax is :
  1202.  
  1203. | .PARAGRAPH [attr1 attr1-parameters [attr2 attr2-parameters [..] ]]
  1204.  
  1205. The allowed parameters to attributes are :
  1206.  
  1207. 1. FONT font-number-in-font-palette : The font number in the font palette, there
  1208. is a standard font palette for MMViewer, winhelp and rtf targets that include 
  1209. the following fonts :
  1210.  
  1211.  0 : Times Roman        (roman Tms Rmn)
  1212.  1 : Symbol             (decor Symbol)
  1213.  2 : Helvetica          (swiss Helv)
  1214.  3 : LinePrinter        (modern LinePrinter)
  1215.  4 : Terminal           (roman Terminal)
  1216.  5 : Times New Roman    (roman Times New Roman)
  1217.  6 : Arial              (swiss Arial)
  1218.  7 : CG Times (WN)      (roman CG Times (WN))
  1219.  8 : Courier            (modern Courier)
  1220.  9 : Modern             (modern Modern)
  1221. 10 : Script             (script Script)
  1222. 11 : Univers (WN)       (swiss Univers (WN))
  1223. 12 : Wingdings          (nil Wingdings)
  1224. 13 : MS Sans Serif      (swiss MS Sans Serif)
  1225.  
  1226. 2. BOLD ON|OFF - Set bold mode to on/off.
  1227.  
  1228. 3. ITALIC ON|OFF - Set italic mode to on/off.
  1229.  
  1230. 4. UNDERLINE ON|OFF - Set underline mode on/off.
  1231.  
  1232. 5. SIZE font-size - Set the size of the font.
  1233.  
  1234. 6. BOX NONE|NORMAL|THICK|SHADOW|DOUBLE - Print paragraph in a box which has one
  1235. of the described borders : NONE is no border at all.
  1236.  
  1237. 7. ALIGN LEFT|RIGHT|CENTER|JUSTIFY - Print the text in the paragraph aligned
  1238. to one of the sides, the center or justified in the paragraph.
  1239.  
  1240. 8. COLOR color-number-in-color-palette - The numbers are the same numbers used
  1241. for dos native systems and described in the help definition format section
  1242. above, regarding the .LINKCOLOR, .TEXTCOLOR and .LINKHIGH statements.
  1243.  
  1244. Example :
  1245.  
  1246. | .PAR BOX SHADOW FONT 13 BOLD ON
  1247. |    ... some text here ..
  1248. | .ENDPAR
  1249.  
  1250. Will display the paragraph in a shadow bordered box, using font 13 in the 
  1251. palette (MS Sans Serif assuming that the original palette is used) with bold
  1252. characters.
  1253.  
  1254. Related Topics :
  1255. Technical Documentation
  1256. Help Definition
  1257.  
  1258.  
  1259. Topics can be associated to groups using the .GROUPS statement in the topic
  1260. heading. Menus to these groups can later be created by using the 
  1261. command .INSERT GROUP group-name in the topic text.
  1262.  
  1263. An example will clarify the use of this function :
  1264.  
  1265. Let us assume that we have a car's collectors database, where the description
  1266. of each car is a topic. We would like to present a hierarchy to the user that
  1267. looks like that : 
  1268.  
  1269. Overview Screen
  1270.    |
  1271.    +--------- Cars by Country
  1272.    |               |
  1273.    |               +------------ U.S.A ... List of cars manufactured in U.S.A
  1274.    |               +------------ U.K.
  1275.    |               +------------ Italy
  1276.    |
  1277.    +--------- Cars by Maker
  1278.    |               |
  1279.    |               +------------ Alfa-Romeo ... List of Alfa-Romeo models
  1280.    |               +------------ GM
  1281.    |               +------------ Mazda
  1282.    |
  1283.    +--------- Cars by type
  1284.                    |
  1285.                    +------------ 4x4 & Jeeps
  1286.                    +------------ Sport Cars
  1287.                    +------------ Family Sedans
  1288.                         
  1289. We will create group references in the topics using the .GROUPS statement,
  1290. The Alfa Romeo Spider 2000 topic will look like :
  1291.  
  1292. | .topic alfa_romeo_spider_2000
  1293. | .title Alfa Romeo Spider 2000
  1294. | .keywords alfa spider convertible sport classic
  1295. | .groups italian alfa sport
  1296. | 
  1297. | The Alfa Romeo ... 
  1298. | 
  1299. | 
  1300. | .end-topic
  1301.  
  1302. The Italian Cars Directory topic will be :
  1303.  
  1304. | .topic italy_directory
  1305. | .title Italian Cars Directory
  1306. | .keywords directory
  1307. | 
  1308. | Cars Manufactured in Italy :
  1309. | 
  1310. | .insert group italian
  1311. | 
  1312. | .end-topic
  1313.  
  1314. If our database includes 3 cars that have a reference to the Italian group
  1315. this will be the equivalent of writing :
  1316.  
  1317. | .topic italy_directory
  1318. | .title Italian Cars Directory
  1319. | .keywords directory
  1320. | 
  1321. | Cars Manufactured in Italy :
  1322. | 
  1323. | ~Alfa Romeo Spider 2000~alfa_romeo_spider_2000~
  1324. | ~Ferrari 308 GTS~Ferrari_308_gts~
  1325. | ~Fiat Uno 70S~fiat_uno_70s~
  1326. | 
  1327. | .end-topic
  1328.  
  1329. Related Topics :
  1330. Technical Documentation
  1331. .HDF Syntax
  1332. Conditional Defines
  1333.  
  1334. helpC provides mechanism to handle link exceptions. An exception is a link
  1335. to an identifier that is not defined as a Topic or PopUp. In order to help
  1336. you find these errors helpC contains the cross reference report that can
  1337. be produced using the /R+ switch. You can browse the HELPC.LST file generated
  1338. by helpC if a cross reference report is generated, and search for the string
  1339. ERROR that describes undefined links.
  1340.  
  1341. helpC provides additional exception handling facilities. When an error is found
  1342. during compile helpC can perform on of the following actions :
  1343.  
  1344. 0: No Check - Default - helpC does not do anything. The link is passed as is to
  1345.               the target. The target help engine/compiler will handle the 
  1346.               exception as it is implemented.
  1347.  
  1348. 1: Trap     - helpC will replace the link key with the key ERROR. It is the 
  1349.               responsibility of the help database author to provide such a
  1350.               topic/popup.
  1351.  
  1352. 2: Strip    - helpC will pass the text of the link to the target with no link
  1353.               support. The text will appear as normal text.
  1354.  
  1355. 3: Delete   - Both the text and the link will be deleted and will not appear in
  1356.               the target.
  1357.  
  1358. 9: Abort    - helpC will abort, with an error message, indicating the line the 
  1359.               link is defined. This mode is recommended when you are debugging 
  1360.               your help database.
  1361.  
  1362. You can set the error level using the following techniques :
  1363.  
  1364. - Use the /EL=x switch on the helpC command line.
  1365.  
  1366. - Use the .ERRORLEVEL x .HDF statement.
  1367.  
  1368. Important Points :
  1369.  
  1370. 1. When errorLevel = 0 (default) no topic database is created during pass 1,
  1371. if you set .errorlevel somewhere in your source, after some topics/popups
  1372. have been defined, these topics will not be in the symbol table created by
  1373. helpC and will be considered an exception!.
  1374.  
  1375. 2. You can use the /FC+ switch to "Force Collection" of Topics data, even when
  1376. the ERRORLEVEL is 0.
  1377.  
  1378. Related Topics :
  1379. Technical Documentation
  1380. .HDF Syntax
  1381. Help Compiler
  1382.  
  1383.  
  1384. Native Graphic support is provided by graphic "links", and graphic object
  1385. definitions.
  1386.  
  1387. In order to incorporate graphics into your database, use the .GRAPHIC
  1388. command to define a graphic object. This command associates a graphic file
  1389. with a unique identifier.
  1390.  
  1391. Whenever you want to use the graphic image in one of your topics, you should
  1392. define a link with the following syntax :
  1393.  
  1394. ~Link Text in non-graphic targets~graphic-identifier~
  1395.  
  1396. If the target of the compiler has no HELPC native graphic support, the 
  1397. "Link Text in non-graphic targets" sentance will be used, if the target 
  1398. is supported, the graphic-identifier will be displayed.
  1399.  
  1400. In this version of HLPDK native graphics support is provided for WINHELP,
  1401. Microsoft Multimedia Viewer (MMViewer) and OS/2 IPF Bitmaps.
  1402.  
  1403. Notice that the graphic-identifier must be unique, and must not be identical
  1404. to a topic/popup/sound name. Please refer to the Links section for
  1405. link recognition sequence information.
  1406.  
  1407. Link Modifiers are attributes that are defined after the link name, separated
  1408. with the ";" character.
  1409.  
  1410. The following modifiers are defined for Graphic support :
  1411.  
  1412. Left   : Align the graphic object to the left of the window.
  1413. Right  : Align the graphic object to the right of the window.
  1414. Center : Align the graphic object to the center of the window.
  1415.  
  1416. Please refer to one of the standard documentation examples that are supplied
  1417. with the HLPDK package, for demos of graphic use.
  1418.  
  1419. Related Topics :
  1420. Technical Documentation
  1421. .HDF Syntax
  1422. Help Compiler
  1423. Links
  1424.  
  1425. Sound support is provided by sound "links", and sound object definition.
  1426.  
  1427. In order to incorporate sound into your database, use the .SOUND command
  1428. to define a sound object. This command associates a sound file (WAV in windows)
  1429. with a unique identifier.
  1430.  
  1431. Whenever you want to use the sound object in one of your topics, you have to
  1432. define a link with the following syntax :
  1433.  
  1434. ~Text To Be Clicked On~sound-identifier~
  1435.  
  1436. Currently, Sound support is available only in the MMViewer and winHelp targets.
  1437. The name of the sound object in this version should be a WAV file, that 
  1438. is in the \WINDOWS directory. The WINDOWS MMSYSTEM multi-media support looks
  1439. for the sound file in this directory!.
  1440.  
  1441. Related Topics :
  1442. Technical Documentation
  1443. .HDF Syntax
  1444. Help Compiler
  1445. Links
  1446.  
  1447. Applications can be launched from the help database using application launch 
  1448. links, and application definitions.
  1449.  
  1450. An application has to be defined using the .APPLICATION statement that uses the
  1451. following syntax :
  1452. | .APPLICATION application-id 'application-activation-code'
  1453. Where application-id is the identifier to the application that will be used 
  1454. in application launch links, and the application-activation-code is the 
  1455. [optional] path to the application and the application executable. If 
  1456. parameters should be specified, the application-activation-code should be
  1457. surrounded by quotes, with a space separating the path to the application from
  1458. the parameters.
  1459.  
  1460. When you want to include an application launch in the topic text, the 
  1461. application-id should be used as the key of a link.
  1462. e.g. ~Press Here To Run XXX.EXE~application-id~
  1463.  
  1464.  
  1465. Related Topics :
  1466. Technical Documentation
  1467. .HDF Syntax
  1468. Help Compiler
  1469. Links
  1470.  
  1471. HELPC supports multiple file target databases, with the use of the following
  1472. HDF statements : .EXTLINK, and .EXPORT .
  1473.  
  1474. When a link that exists in an external database is needed, the .EXTLINK 
  1475. statement is used to define the properties and attributes of that link.
  1476.  
  1477. The most important property - is the database name, that defines which 
  1478. database should be called. Other attributes include the title, keywords,
  1479. numeric references and groups this external topic should be associated with.
  1480.  
  1481. If we have a "simple" complex project, with only 2 databases, and links 
  1482. between them, we might not find it difficult to define the "public" links
  1483. of database 1 in database 2, and vice versa, but - if the project involves
  1484. more databases, we might find it hard to create these public references to
  1485. all external database, in each database. We can, however, define .EXTLINK
  1486. statements of the public links of each database, in a separate file, and
  1487. use the .INCLUDE statement to include them, in the other statements.
  1488.  
  1489. HELPC can be used, with the /PP+ switch, to create these "reference" export
  1490. files, with the name of database.EXP when we use the following command :
  1491. HELPC /PP+ database-name
  1492. If we want a .EXTLINK statement to be created for a topic, we have to
  1493. add the .EXPORT attribute to the topic defintion. Amn alternative is to use
  1494. the /EA+ switch of the HELPC compiler, that exports all topics in the database,
  1495. in a PreProcess target compile (/PP+).
  1496.  
  1497. The .EXTLINK statement has the following syntax :
  1498.  
  1499. | .EXTLINK database 'topic-identifier'
  1500. | [.TITLE topic-title]
  1501. | [.REFERENCE topic-numeric-reference]
  1502. | [.KEYWORDS keyword [keyword ..] ]
  1503. | [.GROUPS group [group ..] ]
  1504. | .END-EXTLINK
  1505.  
  1506. Where database is the name of the external database that the link is in,
  1507. topic-identifier is the id of the link in the external database, title, 
  1508. keywords and groups have the same meaning as in the .TOPIC definition, and
  1509. the topc-numeric-reference is a numeric reference associated with the 
  1510. topic, in the external database, if this is needed.
  1511.  
  1512. Related Topics :
  1513. Technical Documentation
  1514. .HDF Syntax
  1515. Help Compiler
  1516.  
  1517. The HDF syntax can be extended by creating "User Defined Link Templates", 
  1518. with these templates special links can be created, that can be used to support
  1519. additional link types.
  1520.  
  1521. In order to create a user link template, use the following statement :
  1522.  
  1523. | .USERLINK userlink-id template
  1524.  
  1525. Where userlink-id is the name of the template, and template defines the way
  1526. the link will be translated.
  1527.  
  1528. The template can include the following substitution characters :
  1529.  
  1530. %%              - Replace with a %
  1531. %t              - Replace with the text of the link
  1532. %k              - Replace with the key of the link
  1533. %1, %2, .. %5   - Replace with parameter #x
  1534. %o              - Replace with target (output) database name.
  1535. %c              - Replace with context-id (topic name) of current topic.
  1536. %g1, %g2, ..    - Replace with the graphic object whose id is in parameter x.
  1537. %s1, %s2, ..    - Replace with the sound object whose id is in parameter x.
  1538. %a1, %a2, ..    - Replace with the application object, whose id is in parm x.
  1539. %e1, %e2, ..    - Replace with the embedded object, whose name is in parm x. 
  1540.                   Notice, that only the file name and extention are returned,
  1541.                   while in the %gx, %sx and %ax, the entire path is returned.
  1542.  
  1543. User links can be used in the topic text with the following syntax :
  1544.  
  1545.    .. some text ~link-text~userlink-id(param1 param2 ..)~ .. more text
  1546.  
  1547. Use this command to extend the HDF syntax. You can even create special 
  1548. libraries to support video/animation etc.. from the help databases, with these
  1549. extentions.
  1550.  
  1551. e.g. - To create a link to a topic, with a graphic bitmap, we could define
  1552. the following User Link : (Example for winHelp/MMViewer)
  1553.  
  1554. | .userlink graphicJump '{\uldb \{bmc %g1\} %t}{\v %2}'
  1555.  
  1556. And assuming we defined a graphic object as 
  1557.  
  1558. | .graphic mypicture ronp.bmp
  1559.  
  1560. We could create a graphic links such as :
  1561.  
  1562.   Click ~Ron Loewy~graphicJump(mypicture ronTopic)~ to know about the author.
  1563.  
  1564. In the target RTF this will be translated to :
  1565.  
  1566.   Click {\uldb \{bmc ronp.bmp\} Ron Loewy}{\v ronTopic} to know about the author.
  1567.  
  1568. Related Topics :
  1569. Technical Documentation
  1570. Links
  1571. .HDF Syntax
  1572. Help Compiler
  1573.  
  1574.   The topic index table format is as follows :
  1575.  
  1576.   TOPIC     - 40 characters string key - this is the topic "name".
  1577.   FILENAME  - 38 characters string field - includes the name of the
  1578.               help raw data file. (Notice - V1.0 ignores the value of this 
  1579.               field, it is here for future expansion).
  1580.   START     - longint (long) field that contains the offset from the data file
  1581.               start, to the start of the topics text data, in bytes.
  1582.   LEN       - longint (long) field that contains the length (in bytes) of the 
  1583.               text data of the topic.
  1584.   TITLE     - 70 characters string key - the title of the topic.
  1585.   TTYPE     - 1 character - topic type. Currently supported types are :
  1586.               'T' = Topic.
  1587.               'P' = Popup.
  1588.  
  1589. Related Topics :
  1590. Technical Documentation
  1591. Links Index Format
  1592. Keywords Index Format
  1593. Set File Format
  1594.  
  1595.   The links index table format is as follows :
  1596.  
  1597.   TOPIC     - 40 characters string key - the name of the topic that 
  1598.               has the link.
  1599.   SEQ       - integer (int) key - contains the sequential number of 
  1600.               the link in the topic. (This way you can assign the links
  1601.               order in the topic).
  1602.   LINK      - 40 characters string key - the name of the link topic to
  1603.               display if the link is chosen.
  1604.   LINE      - integer (int) field - the line (from the start of the topic) 
  1605.               this link is displayed on.
  1606.   COL       - integer (int) field - the column this link is displayed on.
  1607.   TXT       - 70 characters string field - the text to display on the line.
  1608.  
  1609. Related Topics :
  1610. Technical Documentation
  1611. Topic Index Format
  1612. Keywords Index Format
  1613. Set File Format
  1614.  
  1615.   The set file is a text file that contains one entry in each line, using
  1616.  the following format :
  1617.  
  1618. help-database-engine
  1619. version-of-generating-compiler
  1620. topic-index-table name
  1621. links-index-table name
  1622. keywords-index-table name
  1623. help-raw-data-file name
  1624. number-of-topics
  1625. length-of-file
  1626. link-normal-color
  1627. link-high-color
  1628. text-normal-color
  1629.  
  1630. The help-database-engine values available today are DEF=Paradox and 
  1631. MEM=memory Tables.
  1632.  
  1633. Related Topics:
  1634. Technical Documentation
  1635. Topic Index Format
  1636. Links Index Format
  1637. Keywords Index Format
  1638.  
  1639.   The keywords index table format is as follows :
  1640.  
  1641.   KEYWORD   - 40 characters string key - the keyword.
  1642.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  1643.               assigned to.
  1644.  
  1645.   Notice - the database will include a row for each keyword, that has the 
  1646.   TOPIC field blank. This is used to display the first list of keywords, that
  1647.   if chosen, will display the 2nd list of topics that have the chosen keyword
  1648.   in their .KEYWORDS definition.
  1649.  
  1650. Related Topics:
  1651. Technical Documentation
  1652. Topic Index Format
  1653. Links Index Format
  1654. Set File Format
  1655.  
  1656. The following products/packages provide additional HLPDK functionality :
  1657.  
  1658. 1. Name         : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program. 
  1659.    Version      : 2.3
  1660.    Availability : IL2HDK22.ZIP.
  1661.    Status       : Free. 
  1662.    Author       : Ron Loewy.
  1663.  
  1664. 2. Name         : HPCHDK - HelpPC 2 HLPDK convert program.
  1665.    Version      : 1.0
  1666.    Availability : HPCHDK10.ZIP.
  1667.    Status       : Free.
  1668.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  1669.  
  1670. 3. Name         : SCANHELP - Turbo Pascal Scanner to help.
  1671.    Version      : 3.13
  1672.    Availability : SCANH313.ZIP (Contact Author)
  1673.    Status       : Shareware.
  1674.    Author       : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA)
  1675.  
  1676. 4. Name         : NG2HDK - Norton Guides 2 HLPDK convert program.
  1677.    Version      : 1.0
  1678.    Availability : NG2HDK10.ZIP
  1679.    Status       : Free.
  1680.    Author       : Ron Loewy.
  1681.  
  1682. 5. Name         : NEWSDB - usenet News Clips Hypertext generator.
  1683.    Version      : 1.0.
  1684.    Availability : NEWSDB10.ZIP
  1685.    Status       : Shareware.
  1686.    Author       : Ron Loewy.
  1687.  
  1688. 6. Name         : POPHDK - POPHELP 2 HLPDK convert program.
  1689.    Version      : 1.0
  1690.    Availability : POPHDK10.ZIP.
  1691.    Status       : Free.
  1692.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  1693.  
  1694. 7. Name         : JARG2HDK - Jargon File to HLPDK convert program.
  1695.    Version      : 1.0
  1696.    Availability : ? (Contact Author)
  1697.    Status       : ?
  1698.    Author       : Slren Pingel Dalsgaard (pingel@daimi.aau.dk)
  1699.  
  1700. Currently under development : RTF2HDK, RC2HDK, HDKLIB and more ..
  1701.  
  1702.  
  1703.